Skip to content

docs(doc-1389): add gateway api sync examples and cli guidance#2163

Merged
zerbitx merged 3 commits into
loft-sh:mainfrom
zerbitx:DOC-1389
Jun 10, 2026
Merged

docs(doc-1389): add gateway api sync examples and cli guidance#2163
zerbitx merged 3 commits into
loft-sh:mainfrom
zerbitx:DOC-1389

Conversation

@zerbitx

@zerbitx zerbitx commented May 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • new to-host gateway-api.mdx with Gateway, HTTPRoute, TLSRoute, ReferenceGrant, BackendTLSPolicy examples drawn from the smoke tests
  • new from-host gateway-classes.mdx mirroring ingress-classes.mdx, plus a troubleshoot/gateway-api-sync.mdx page for RefNotPermitted / SyncError events
  • cross-link ingresses.mdx and refocus custom-resources.mdx's gateway example to Istio-waypoint-only
  • generate gatewayApi and gatewayClasses config partials; register both paths in hack/vcluster/partials/main.go

Content Description

Preview Link

Internal Reference

Closes DOC-1389

AI review: mention @claude in a comment to request a review or changes. See CONTRIBUTING.md for available commands.

FORK LIMITATION: @claude does not work on pull requests opened from forks. GitHub Actions cannot access the required secrets for fork-originated PRs. To use AI review, push your branch directly to this repository.

@netlify /docs

@netlify

netlify Bot commented May 20, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for vcluster-docs-site ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 74961c0
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6a295ef401e02f0008767edc
😎 Deploy Preview https://deploy-preview-2163--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

github-actions Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

DOC-1389: Add vcluster Gateway API examples and CLI guidance

@zerbitx zerbitx marked this pull request as ready for review May 21, 2026 02:53
@zerbitx zerbitx requested a review from a team as a code owner May 21, 2026 02:53
djwfyi
djwfyi requested changes May 22, 2026
View reviewed changes

@djwfyi djwfyi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of minor wording updates.
I also want to make sure that anything that's autogenerated from upstream code isn't introducing new uses of old terminology to those files.

And there's a question of whether we need to introduce a yarn.lock file to the repo where we haven't had one before.

Comment thread vcluster/_partials/config/sync/fromHost/gatewayClasses.mdx Outdated
Comment thread vcluster/_partials/config/sync/fromHost.mdx Outdated
Comment thread vcluster/configure/vcluster-yaml/sync/to-host/networking/gateway-api.mdx Outdated
Comment thread vcluster/configure/vcluster-yaml/sync/to-host/networking/gateway-api.mdx Outdated
Comment thread yarn.lock Outdated
@zerbitx zerbitx marked this pull request as draft May 28, 2026 11:16
@djwfyi

djwfyi commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

PR vs main analysis

PR 2244 (merged Jun 5) and schema automation have already landed most of this PR's content. Here's the breakdown:

Already in main — superseded

This PR's change What's in main
New (1,184 lines with examples) PR 2244 added a stub at the same path
New PR 2244 added this
Schema additions in default_values.yaml and vcluster.schema.json Already merged
gatewayApi/gatewayClasses entries in aggregate partials (sync/toHost.mdx, sync/fromHost.mdx) Already generated and present
Terminology fixes (host cluster → control plane cluster) in YAML comments Already in main

Still missing — genuinely new in this PR

File Content
vcluster/configure/vcluster-yaml/sync/from-host/gateway-classes.mdx Guide page for gatewayClasses sync (78 lines)
vcluster/troubleshoot/gateway-api-sync.mdx Troubleshooting for RefNotPermitted / SyncError events (152 lines)
vcluster/_partials/config/sync/toHost/gatewayApi.mdx Standalone generated partial (1,276 lines)
vcluster/_partials/config/sync/fromHost/gatewayClasses.mdx Standalone generated partial (301 lines)
hack/vcluster/partials/main.go Registers both new partial paths in the generator

Recommendation

Merging main into this branch would be net helpful. The superseded files will conflict and make it clear what's actually new. The main editorial question is whether the detailed examples in this PR's gateway-api.mdx (1,184 lines) should replace or augment the stub that PR 2244 landed — that conflict is worth resolving rather than discarding.

@djwfyi

djwfyi commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Merged main into branch

Resolved three conflicts:

Schema files (configsrc/vcluster/main/default_values.yaml and vcluster.schema.json): Both sides added the same gatewayApi and gatewayClasses blocks. The only difference was terminology — main had old host cluster / virtual cluster language, the PR branch had the correct control plane cluster / tenant cluster language. Kept the PR branch side.

vcluster/configure/vcluster-yaml/sync/to-host/networking/gateway-api.mdx (add/add): PR branch has 1,184 lines of concrete config examples. Main had a 43-line stub added by PR 2244 whose prose was redundant with key-features/gateway-api.mdx. Kept the PR branch. Condensed the inline Prerequisites admonition to a link to key-features/gateway-api.mdx#prerequisites to avoid duplicating the prerequisites list that PR 2244 already documents there.

@zerbitx zerbitx marked this pull request as ready for review June 9, 2026 20:02
zerbitx added 2 commits June 10, 2026 06:50
@zerbitx
docs(doc-1389): add gateway api sync examples and cli guidance
91f4fbe 
  - new to-host gateway-api.mdx with Gateway, HTTPRoute, TLSRoute, ReferenceGrant, BackendTLSPolicy examples drawn from the smoke tests
  - new from-host gateway-classes.mdx mirroring ingress-classes.mdx, plus a troubleshoot/gateway-api-sync.mdx page for RefNotPermitted / SyncError events
  - cross-link ingresses.mdx and refocus custom-resources.mdx's gateway example to Istio-waypoint-only
  - generate gatewayApi and gatewayClasses config partials; register both paths in hack/vcluster/partials/main.go

Signed-off-by: Ryan Swanson <ryan.swanson@loft.sh>

# Conflicts:
#	vcluster/configure/vcluster-yaml/sync/to-host/networking/gateway-api.mdx
@zerbitx
update examples after testing out, and revert unrelated file changes
e4dd87d 
Signed-off-by: Ryan Swanson <ryan.swanson@loft.sh>
@zerbitx
Update to reflect the new config structure, and behavior
74961c0 
Signed-off-by: Ryan Swanson <ryan.swanson@loft.sh>
@zerbitx zerbitx merged commit f2827ab into loft-sh:main Jun 10, 2026
9 checks passed
@loft-bot loft-bot mentioned this pull request Jun 10, 2026
Merged
djwfyi pushed a commit that referenced this pull request Jun 10, 2026
@loft-bot
[v0.35] docs(doc-1389): add gateway api sync examples and cli guidance (
d05684a 
#2163) (#2257)

* Backport: Copy vcluster/_fragments/patches.mdx to vcluster_versioned_docs/version-0.35.0/_fragments/patches.mdx

* Backport: Copy vcluster/_partials/config/sync.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync.mdx

* Backport: Copy vcluster/_partials/config/sync/fromHost.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/fromHost.mdx

* Backport: Copy vcluster/_partials/config/sync/fromHost/configMaps.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/fromHost/configMaps.mdx

* Backport: Copy vcluster/_partials/config/sync/fromHost/customResources.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/fromHost/customResources.mdx

* Backport: Copy vcluster/_partials/config/sync/fromHost/gatewayClasses.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/fromHost/gatewayClasses.mdx

* Backport: Copy vcluster/_partials/config/sync/fromHost/secrets.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/fromHost/secrets.mdx

* Backport: Copy vcluster/_partials/config/sync/toHost.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/toHost.mdx

* Backport: Copy vcluster/_partials/config/sync/toHost/gatewayApi.mdx to vcluster_versioned_docs/version-0.35.0/_partials/config/sync/toHost/gatewayApi.mdx

* Backport: Copy vcluster/configure/vcluster-yaml/sync/from-host/gateway-classes.mdx to vcluster_versioned_docs/version-0.35.0/configure/vcluster-yaml/sync/from-host/gateway-classes.mdx

* Backport: Copy vcluster/configure/vcluster-yaml/sync/to-host/advanced/custom-resources.mdx to vcluster_versioned_docs/version-0.35.0/configure/vcluster-yaml/sync/to-host/advanced/custom-resources.mdx

* Backport: Copy vcluster/configure/vcluster-yaml/sync/to-host/networking/gateway-api.mdx to vcluster_versioned_docs/version-0.35.0/configure/vcluster-yaml/sync/to-host/networking/gateway-api.mdx

* Backport: Copy vcluster/configure/vcluster-yaml/sync/to-host/networking/ingresses.mdx to vcluster_versioned_docs/version-0.35.0/configure/vcluster-yaml/sync/to-host/networking/ingresses.mdx

* Backport: Copy vcluster/troubleshoot/gateway-api-sync.mdx to vcluster_versioned_docs/version-0.35.0/troubleshoot/gateway-api-sync.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@djwfyi djwfyi djwfyi approved these changes

Assignees

No one assigned

Labels

backport-v0.35

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@zerbitx @djwfyi